AspectK Runtime/io.github.molelabs.aspectk.runtime

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR])

annotation class After(val target: KClass<out Annotation>, val inherits: Boolean = false)

Marks a function inside an Aspect-annotated class as after advice.

data class AnnotationInfo(val type: KClass<out Annotation>, val typeName: String, val args: List<Any?>, val parameterNames: List<String>)

Holds metadata about a single annotation instance present on a method or parameter.

Around

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR])

annotation class Around(val target: KClass<out Annotation>, val inherits: Boolean = false)

Marks a function inside an Aspect-annotated class as around advice.

Aspect

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Aspect

Marks a class or object as an AspectK aspect.

Before

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR])

annotation class Before(val target: KClass<out Annotation>, val inherits: Boolean = false)

Marks a function inside an Aspect-annotated class as before advice.

JoinPoint

interface JoinPoint

Provides contextual information about an intercepted function call.

MethodParameter

data class MethodParameter(val name: String, val type: KClass<*>, val typeName: String, val annotations: List<AnnotationInfo>, val isNullable: Boolean)

Describes a single parameter of an intercepted method.

MethodSignature

data class MethodSignature(val methodName: String, val annotations: List<AnnotationInfo>, val parameter: List<MethodParameter>, val returnType: KClass<*>, val returnTypeName: String)

Compile-time metadata describing the signature of an intercepted method.

ProceedingJoinPoint

interface ProceedingJoinPoint : JoinPoint

Extends JoinPoint with the ability to proceed to the intercepted function's body.

Functions

findAnnotation

inline fun <T : Annotation> JoinPoint.findAnnotation(): AnnotationInfo?

Returns the AnnotationInfo for annotation T present on the intercepted function, or null if no such annotation is present.

inline fun <T : Annotation> MethodSignature.findAnnotation(): AnnotationInfo?

Returns the AnnotationInfo for annotation T present on this method signature, or null if no such annotation is present.

getArg

inline fun <T> AnnotationInfo.getArg(paramName: String): T

Returns the annotation argument value for the parameter named paramName, cast to T.

inline fun <T> JoinPoint.getArg(name: String): T

Returns the argument value for the parameter named name, cast to T.

getArgOrNull

inline fun <T> AnnotationInfo.getArgOrNull(paramName: String): T?

Returns the annotation argument value for the parameter named paramName, cast to T, or null if no such parameter exists or the value cannot be cast to T.

inline fun <T> JoinPoint.getArgOrNull(name: String): T?

Returns the argument value for the parameter named name, cast to T, or null if no such parameter exists or the value cannot be cast to T.

getTarget

inline fun <T> JoinPoint.getTarget(): T

Returns JoinPoint.target cast to T.

getTargetOrNull

inline fun <T> JoinPoint.getTargetOrNull(): T?

Returns JoinPoint.target cast to T, or null if the target is null or cannot be cast to T.